home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1998 November / Freeware November 1998.img / dist / fw_cvs.idb / usr / freeware / info / cvs.info-6.z / cvs.info-6 (.txt)
GNU Info File  |  1998-10-27  |  51KB  |  1,103 lines
  1. This is Info file cvs.info, produced by Makeinfo version 1.67 from the
  2. input file ../../work/ccvs/doc/cvs.texinfo.
  3. START-INFO-DIR-ENTRY
  4. * CVS: (cvs).          Concurrent Versions System
  5. END-INFO-DIR-ENTRY
  6.    Copyright (C) 1992, 1993 Signum Support AB Copyright (C) 1993, 1994
  7. Free Software Foundation, Inc.
  8.    Permission is granted to make and distribute verbatim copies of this
  9. manual provided the copyright notice and this permission notice are
  10. preserved on all copies.
  11.    Permission is granted to copy and distribute modified versions of
  12. this manual under the conditions for verbatim copying, provided also
  13. that the entire resulting derived work is distributed under the terms
  14. of a permission notice identical to this one.
  15.    Permission is granted to copy and distribute translations of this
  16. manual into another language, under the above conditions for modified
  17. versions, except that this permission notice may be stated in a
  18. translation approved by the Free Software Foundation.
  19. File: cvs.info,  Node: import options,  Next: import output,  Up: import
  20. import options
  21. --------------
  22.    This standard option is supported by `import' (*note Common
  23. options::., for a complete description):
  24. `-m MESSAGE'
  25.      Use MESSAGE as log information, instead of invoking an editor.
  26.    There are the following additional special options.
  27. `-b BRANCH'
  28.      See *Note Multiple vendor branches::.
  29. `-k SUBST'
  30.      Indicate the keyword expansion mode desired.  This setting will
  31.      apply to all files created during the import, but not to any files
  32.      that previously existed in the repository.  See *Note Substitution
  33.      modes::, for a list of valid `-k' settings.
  34. `-I NAME'
  35.      Specify file names that should be ignored during import.  You can
  36.      use this option repeatedly.  To avoid ignoring any files at all
  37.      (even those ignored by default), specify `-I !'.
  38.      NAME can be a file name pattern of the same type that you can
  39.      specify in the `.cvsignore' file.  *Note cvsignore::.
  40. `-W SPEC'
  41.      Specify file names that should be filtered during import.  You can
  42.      use this option repeatedly.
  43.      SPEC can be a file name pattern of the same type that you can
  44.      specify in the `.cvswrappers' file. *Note Wrappers::.
  45. File: cvs.info,  Node: import output,  Next: import examples,  Prev: import options,  Up: import
  46. import output
  47. -------------
  48.    `import' keeps you informed of its progress by printing a line for
  49. each file, preceded by one character indicating the status of the file:
  50. `U FILE'
  51.      The file already exists in the repository and has not been locally
  52.      modified; a new revision has been created (if necessary).
  53. `N FILE'
  54.      The file is a new file which has been added to the repository.
  55. `C FILE'
  56.      The file already exists in the repository but has been locally
  57.      modified; you will have to merge the changes.
  58. `I FILE'
  59.      The file is being ignored (*note cvsignore::.).
  60. `L FILE'
  61.      The file is a symbolic link; `cvs import' ignores symbolic links.
  62.      People periodically suggest that this behavior should be changed,
  63.      but if there is a consensus on what it should be changed to, it
  64.      doesn't seem to be apparent.  (Various options in the `modules'
  65.      file can be used to recreate symbolic links on checkout, update,
  66.      etc.; *note modules::..)
  67. File: cvs.info,  Node: import examples,  Prev: import output,  Up: import
  68. import examples
  69. ---------------
  70.    See *Note Tracking sources::, and *Note From files::.
  71. File: cvs.info,  Node: log,  Next: rdiff,  Prev: import,  Up: CVS commands
  72. log--Print out log information for files
  73. ========================================
  74.    * Synopsis: log [options] [files...]
  75.    * Requires: repository, working directory.
  76.    * Changes: nothing.
  77.    Display log information for files.  `log' used to call the RCS
  78. utility `rlog'.  Although this is no longer true in the current
  79. sources, this history determines the format of the output and the
  80. options, which are not quite in the style of the other CVS commands.
  81.    The output includes the location of the RCS file, the "head"
  82. revision (the latest revision on the trunk), all symbolic names (tags)
  83. and some other things.  For each revision, the revision number, the
  84. author, the number of lines added/deleted and the log message are
  85. printed.  All times are displayed in Coordinated Universal Time (UTC).
  86. (Other parts of CVS print times in the local timezone).
  87.    *Warning:* `log' uses `-R' in a way that conflicts with the normal
  88. use inside CVS (*note Common options::.).
  89. * Menu:
  90. * log options::                 log options
  91. * log examples::                log examples
  92. File: cvs.info,  Node: log options,  Next: log examples,  Up: log
  93. log options
  94. -----------
  95.    By default, `log' prints all information that is available.  All
  96. other options restrict the output.
  97.      Print information about the revisions on the default branch,
  98.      normally the highest branch on the trunk.
  99. `-d DATES'
  100.      Print information about revisions with a checkin date/time in the
  101.      range given by the semicolon-separated list of dates.  The date
  102.      formats accepted are those accepted by the `-D' option to many
  103.      other CVS commands (*note Common options::.).  Dates can be
  104.      combined into ranges as follows:
  105.     `D1<D2'
  106.     `D2>D1'
  107.           Select the revisions that were deposited between D1 and D2.
  108.     `<D'
  109.     `D>'
  110.           Select all revisions dated D or earlier.
  111.     `D<'
  112.     `>D'
  113.           Select all revisions dated D or later.
  114.     `D'
  115.           Select the single, latest revision dated D or earlier.
  116.      The `>' or `<' characters may be followed by `=' to indicate an
  117.      inclusive range rather than an exclusive one.
  118.      Note that the separator is a semicolon (;).
  119.      Print only the name of the RCS file, name of the file in the
  120.      working directory, head, default branch, access list, locks,
  121.      symbolic names, and suffix.
  122.      Local; run only in current working directory.  (Default is to run
  123.      recursively).
  124.      Do not print the list of tags for this file.  This option can be
  125.      very useful when your site uses a lot of tags, so rather than
  126.      "more"'ing over 3 pages of tag information, the log information is
  127.      presented without tags at all.
  128.      Print only the name of the RCS file.
  129. `-rREVISIONS'
  130.      Print information about revisions given in the comma-separated
  131.      list REVISIONS of revisions and ranges.  The following table
  132.      explains the available range formats:
  133.     `REV1:REV2'
  134.           Revisions REV1 to REV2 (which must be on the same branch).
  135.     `:REV'
  136.           Revisions from the beginning of the branch up to and
  137.           including REV.
  138.     `REV:'
  139.           Revisions starting with REV to the end of the branch
  140.           containing REV.
  141.     `BRANCH'
  142.           An argument that is a branch means all revisions on that
  143.           branch.
  144.     `BRANCH1:BRANCH2'
  145.           A range of branches means all revisions on the branches in
  146.           that range.
  147.     `BRANCH.'
  148.           The latest revision in BRANCH.
  149.      A bare `-r' with no revisions means the latest revision on the
  150.      default branch, normally the trunk.  There can be no space between
  151.      the `-r' option and its argument.
  152. `-s STATES'
  153.      Print information about revisions whose state attributes match one
  154.      of the states given in the comma-separated list STATES.
  155.      Print the same as `-h', plus the descriptive text.
  156. `-wLOGINS'
  157.      Print information about revisions checked in by users with login
  158.      names appearing in the comma-separated list LOGINS.  If LOGINS is
  159.      omitted, the user's login is assumed.  There can be no space
  160.      between the `-w' option and its argument.
  161.    `log' prints the intersection of the revisions selected with the
  162. options `-d', `-s', and `-w', intersected with the union of the
  163. revisions selected by `-b' and `-r'.
  164. File: cvs.info,  Node: log examples,  Prev: log options,  Up: log
  165. log examples
  166. ------------
  167.    Contributed examples are gratefully accepted.
  168. File: cvs.info,  Node: rdiff,  Next: release,  Prev: log,  Up: CVS commands
  169. rdiff--'patch' format diffs between releases
  170. ============================================
  171.    * rdiff [-flags] [-V vn] [-r t|-D d [-r t2|-D d2]] modules...
  172.    * Requires: repository.
  173.    * Changes: nothing.
  174.    * Synonym: patch
  175.    Builds a Larry Wall format patch(1) file between two releases, that
  176. can be fed directly into the `patch' program to bring an old release
  177. up-to-date with the new release.  (This is one of the few CVS commands
  178. that operates directly from the repository, and doesn't require a prior
  179. checkout.) The diff output is sent to the standard output device.
  180.    You can specify (using the standard `-r' and `-D' options) any
  181. combination of one or two revisions or dates.  If only one revision or
  182. date is specified, the patch file reflects differences between that
  183. revision or date and the current head revisions in the RCS file.
  184.    Note that if the software release affected is contained in more than
  185. one directory, then it may be necessary to specify the `-p' option to
  186. the `patch' command when patching the old sources, so that `patch' is
  187. able to find the files that are located in other directories.
  188. * Menu:
  189. * rdiff options::               rdiff options
  190. * rdiff examples::              rdiff examples
  191. File: cvs.info,  Node: rdiff options,  Next: rdiff examples,  Up: rdiff
  192. rdiff options
  193. -------------
  194.    These standard options are supported by `rdiff' (*note Common
  195. options::., for a complete description of them):
  196. `-D DATE'
  197.      Use the most recent revision no later than DATE.
  198.      If no matching revision is found, retrieve the most recent
  199.      revision (instead of ignoring the file).
  200.      Local; don't descend subdirectories.
  201.      Examine directories recursively.  This option is on by default.
  202. `-r TAG'
  203.      Use revision TAG.
  204.    In addition to the above, these options are available:
  205.      Use the context diff format.  This is the default format.
  206.      Create a summary change report instead of a patch.  The summary
  207.      includes information about files that were changed or added
  208.      between the releases.  It is sent to the standard output device.
  209.      This is useful for finding out, for example, which files have
  210.      changed between two dates or revisions.
  211.      A diff of the top two revisions is sent to the standard output
  212.      device.  This is most useful for seeing what the last change to a
  213.      file was.
  214.      Use the unidiff format for the context diffs.  This option is not
  215.      available if your `diff' does not support the unidiff format.
  216.      Remember that old versions of the `patch' program can't handle the
  217.      unidiff format, so if you plan to post this patch to the net you
  218.      should probably not use `-u'.
  219. `-V VN'
  220.      Expand keywords according to the rules current in RCS version VN
  221.      (the expansion format changed with RCS version 5).  Note that this
  222.      option is no longer accepted.  CVS will always expand keywords the
  223.      way that RCS version 5 does.
  224. File: cvs.info,  Node: rdiff examples,  Prev: rdiff options,  Up: rdiff
  225. rdiff examples
  226. --------------
  227.    Suppose you receive mail from foo@bar.com asking for an update from
  228. release 1.2 to 1.4 of the tc compiler.  You have no such patches on
  229. hand, but with CVS that can easily be fixed with a command such as this:
  230.      $ cvs rdiff -c -r FOO1_2 -r FOO1_4 tc | \
  231.      $$ Mail -s 'The patches you asked for' foo@bar.com
  232.    Suppose you have made release 1.3, and forked a branch called
  233. `R_1_3fix' for bugfixes.  `R_1_3_1' corresponds to release 1.3.1, which
  234. was made some time ago.  Now, you want to see how much development has
  235. been done on the branch.  This command can be used:
  236.      $ cvs patch -s -r R_1_3_1 -r R_1_3fix module-name
  237.      cvs rdiff: Diffing module-name
  238.      File ChangeLog,v changed from revision 1.52.2.5 to 1.52.2.6
  239.      File foo.c,v changed from revision 1.52.2.3 to 1.52.2.4
  240.      File bar.h,v changed from revision 1.29.2.1 to 1.2
  241. File: cvs.info,  Node: release,  Next: rtag,  Prev: rdiff,  Up: CVS commands
  242. release--Indicate that a Module is no longer in use
  243. ===================================================
  244.    * release [-d] directories...
  245.    * Requires: Working directory.
  246.    * Changes: Working directory, history log.
  247.    This command is meant to safely cancel the effect of `cvs checkout'.
  248. Since CVS doesn't lock files, it isn't strictly necessary to use this
  249. command.  You can always simply delete your working directory, if you
  250. like; but you risk losing changes you may have forgotten, and you leave
  251. no trace in the CVS history file (*note history file::.) that you've
  252. abandoned your checkout.
  253.    Use `cvs release' to avoid these problems.  This command checks that
  254. no uncommitted changes are present; that you are executing it from
  255. immediately above a CVS working directory; and that the repository
  256. recorded for your files is the same as the repository defined in the
  257. module database.
  258.    If all these conditions are true, `cvs release' leaves a record of
  259. its execution (attesting to your intentionally abandoning your
  260. checkout) in the CVS history log.
  261. * Menu:
  262. * release options::             release options
  263. * release output::              release output
  264. * release examples::            release examples
  265. File: cvs.info,  Node: release options,  Next: release output,  Up: release
  266. release options
  267. ---------------
  268.    The `release' command supports one command option:
  269.      Delete your working copy of the file if the release succeeds.  If
  270.      this flag is not given your files will remain in your working
  271.      directory.
  272.      *Warning:*  The `release' command deletes all directories and
  273.      files recursively.  This has the very serious side-effect that any
  274.      directory that you have created inside your checked-out sources,
  275.      and not added to the repository (using the `add' command; *note
  276.      Adding files::.) will be silently deleted--even if it is non-empty!
  277. File: cvs.info,  Node: release output,  Next: release examples,  Prev: release options,  Up: release
  278. release output
  279. --------------
  280.    Before `release' releases your sources it will print a one-line
  281. message for any file that is not up-to-date.
  282.    *Warning:*  Any new directories that you have created, but not added
  283. to the CVS directory hierarchy with the `add' command (*note Adding
  284. files::.) will be silently ignored (and deleted, if `-d' is specified),
  285. even if they contain files.
  286. `U FILE'
  287. `P FILE'
  288.      There exists a newer revision of this file in the repository, and
  289.      you have not modified your local copy of the file (`U' and `P'
  290.      mean the same thing).
  291. `A FILE'
  292.      The file has been added to your private copy of the sources, but
  293.      has not yet been committed to the repository.  If you delete your
  294.      copy of the sources this file will be lost.
  295. `R FILE'
  296.      The file has been removed from your private copy of the sources,
  297.      but has not yet been removed from the repository, since you have
  298.      not yet committed the removal.  *Note commit::.
  299. `M FILE'
  300.      The file is modified in your working directory.  There might also
  301.      be a newer revision inside the repository.
  302. `? FILE'
  303.      FILE is in your working directory, but does not correspond to
  304.      anything in the source repository, and is not in the list of files
  305.      for CVS to ignore (see the description of the `-I' option, and
  306.      *note cvsignore::.).  If you remove your working sources, this
  307.      file will be lost.
  308. File: cvs.info,  Node: release examples,  Prev: release output,  Up: release
  309. release examples
  310. ----------------
  311.    Release the module, and delete your local working copy of the files.
  312.      $ cd ..         # You must stand immediately above the
  313.                      # sources when you issue `cvs release'.
  314.      $ cvs release -d tc
  315.      You have [0] altered files in this repository.
  316.      Are you sure you want to release (and delete) module `tc': y
  317.      $
  318. File: cvs.info,  Node: rtag,  Next: tag,  Prev: release,  Up: CVS commands
  319. rtag--Add a symbolic tag to a module
  320. ====================================
  321.    * rtag [-falnR] [-b] [-d] [-r tag | -Ddate] symbolic_tag modules...
  322.    * Requires: repository.
  323.    * Changes: repository.
  324.    * Synonym: rfreeze
  325.    You can use this command to assign symbolic tags to particular,
  326. explicitly specified source revisions in the repository.  `rtag' works
  327. directly on the repository contents (and requires no prior checkout).
  328. Use `tag' instead (*note tag::.), to base the selection of revisions on
  329. the contents of your working directory.
  330.    If you attempt to use a tag name that already exists, CVS will
  331. complain and not overwrite that tag.  Use the `-F' option to force the
  332. new tag value.
  333. * Menu:
  334. * rtag options::                rtag options
  335. File: cvs.info,  Node: rtag options,  Up: rtag
  336. rtag options
  337. ------------
  338.    These standard options are supported by `rtag' (*note Common
  339. options::., for a complete description of them):
  340. `-D DATE'
  341.      Tag the most recent revision no later than DATE.
  342.      Only useful with the `-D DATE' or `-r TAG' flags.  If no matching
  343.      revision is found, use the most recent revision (instead of
  344.      ignoring the file).
  345.      Overwrite an existing tag of the same name on a different revision.
  346.      Local; run only in current working directory.
  347.      Do not run any tag program that was specified with the `-t' flag
  348.      inside the `modules' file.  (*note modules::.).
  349.      Tag directories recursively.  This is on by default.
  350. `-r TAG'
  351.      Only tag those files that contain TAG.  This can be used to rename
  352.      a tag: tag only the files identified by the old tag, then delete
  353.      the old tag, leaving the new tag on exactly the same files as the
  354.      old tag.
  355.    In addition to the above common options, these options are available:
  356.      Use the `-a' option to have `rtag' look in the `Attic' (*note
  357.      Attic::.) for removed files that contain the specified tag.  The
  358.      tag is removed from these files, which makes it convenient to
  359.      re-use a symbolic tag as development continues (and files get
  360.      removed from the up-coming distribution).
  361.      Make the tag a branch tag.  *Note Branching and merging::.
  362.      Delete the tag instead of creating it.
  363.      In general, tags (often the symbolic names of software
  364.      distributions) should not be removed, but the `-d' option is
  365.      available as a means to remove completely obsolete symbolic names
  366.      if necessary (as might be the case for an Alpha release, or if you
  367.      mistagged a module).
  368. File: cvs.info,  Node: tag,  Next: update,  Prev: rtag,  Up: CVS commands
  369. tag--Add a symbolic tag to checked out versions of files
  370. ========================================================
  371.    * tag [-lR] [-b] [-c] [-d] symbolic_tag [files...]
  372.    * Requires: working directory, repository.
  373.    * Changes: repository.
  374.    * Synonym: freeze
  375.    Use this command to assign symbolic tags to the nearest repository
  376. versions to your working sources.  The tags are applied immediately to
  377. the repository, as with `rtag', but the versions are supplied
  378. implicitly by the CVS records of your working files' history rather than
  379. applied explicitly.
  380.    One use for tags is to record a snapshot of the current sources when
  381. the software freeze date of a project arrives.  As bugs are fixed after
  382. the freeze date, only those changed sources that are to be part of the
  383. release need be re-tagged.
  384.    The symbolic tags are meant to permanently record which revisions of
  385. which files were used in creating a software distribution.  The
  386. `checkout' and `update' commands allow you to extract an exact copy of
  387. a tagged release at any time in the future, regardless of whether files
  388. have been changed, added, or removed since the release was tagged.
  389.    This command can also be used to delete a symbolic tag, or to create
  390. a branch.  See the options section below.
  391.    If you attempt to use a tag name that already exists, CVS will
  392. complain and not overwrite that tag.  Use the `-F' option to force the
  393. new tag value.
  394. * Menu:
  395. * tag options::                 tag options
  396. File: cvs.info,  Node: tag options,  Up: tag
  397. tag options
  398. -----------
  399.    These standard options are supported by `tag' (*note Common
  400. options::., for a complete description of them):
  401.      Overwrite an existing tag of the same name on a different revision.
  402.      Local; run only in current working directory.
  403.      Tag directories recursively.  This is on by default.
  404.    Two special options are available:
  405.      Make the tag a branch tag (*note Branching and merging::.),
  406.      allowing concurrent, isolated development.  This is most useful
  407.      for creating a patch to a previously released software
  408.      distribution.
  409.      Check that all files which are to be tagged are unmodified.  This
  410.      can be used to make sure that you can reconstruct the current file
  411.      contents.
  412.      Delete a tag.
  413.      If you use `cvs tag -d symbolic_tag', the symbolic tag you specify
  414.      is deleted instead of being added.  Warning: Be very certain of
  415.      your ground before you delete a tag; doing this permanently
  416.      discards some historical information, which may later turn out to
  417.      be valuable.
  418. File: cvs.info,  Node: update,  Prev: tag,  Up: CVS commands
  419. update--Bring work tree in sync with repository
  420. ===============================================
  421.    * update [-AdflPpR] [-d] [-r tag|-D date] files...
  422.    * Requires: repository, working directory.
  423.    * Changes: working directory.
  424.    After you've run checkout to create your private copy of source from
  425. the common repository, other developers will continue changing the
  426. central source.  From time to time, when it is convenient in your
  427. development process, you can use the `update' command from within your
  428. working directory to reconcile your work with any revisions applied to
  429. the source repository since your last checkout or update.
  430. * Menu:
  431. * update options::              update options
  432. * update output::               update output
  433. File: cvs.info,  Node: update options,  Next: update output,  Up: update
  434. update options
  435. --------------
  436.    These standard options are available with `update' (*note Common
  437. options::., for a complete description of them):
  438. `-D date'
  439.      Use the most recent revision no later than DATE.  This option is
  440.      sticky, and implies `-P'.  See *Note Sticky tags::, for more
  441.      information on sticky tags/dates.
  442.      Only useful with the `-D DATE' or `-r TAG' flags.  If no matching
  443.      revision is found, retrieve the most recent revision (instead of
  444.      ignoring the file).
  445. `-k KFLAG'
  446.      Process keywords according to KFLAG.  See *Note Keyword
  447.      substitution::.  This option is sticky; future updates of this
  448.      file in this working directory will use the same KFLAG.  The
  449.      `status' command can be viewed to see the sticky options.  See
  450.      *Note Invoking CVS::, for more information on the `status' command.
  451.      Local; run only in current working directory.  *Note Recursive
  452.      behavior::.
  453.      Prune empty directories.  See *Note Moving directories::.
  454.      Pipe files to the standard output.
  455.      Update directories recursively (default).  *Note Recursive
  456.      behavior::.
  457. `-r rev'
  458.      Retrieve revision/tag REV.  This option is sticky, and implies
  459.      `-P'.  See *Note Sticky tags::, for more information on sticky
  460.      tags/dates.
  461.    These special options are also available with `update'.
  462.      Reset any sticky tags, dates, or `-k' options.  See *Note Sticky
  463.      tags::, for more information on sticky tags/dates.
  464.      Create any directories that exist in the repository if they're
  465.      missing from the working directory.  Normally, `update' acts only
  466.      on directories and files that were already enrolled in your
  467.      working directory.
  468.      This is useful for updating directories that were created in the
  469.      repository since the initial checkout; but it has an unfortunate
  470.      side effect.  If you deliberately avoided certain directories in
  471.      the repository when you created your working directory (either
  472.      through use of a module name or by listing explicitly the files
  473.      and directories you wanted on the command line), then updating
  474.      with `-d' will create those directories, which may not be what you
  475.      want.
  476. `-I NAME'
  477.      Ignore files whose names match NAME (in your working directory)
  478.      during the update.  You can specify `-I' more than once on the
  479.      command line to specify several files to ignore.  Use `-I !' to
  480.      avoid ignoring any files at all.  *Note cvsignore::, for other
  481.      ways to make CVS ignore some files.
  482. `-WSPEC'
  483.      Specify file names that should be filtered during update.  You can
  484.      use this option repeatedly.
  485.      SPEC can be a file name pattern of the same type that you can
  486.      specify in the `.cvswrappers' file. *Note Wrappers::.
  487. `-jREVISION'
  488.      With two `-j' options, merge changes from the revision specified
  489.      with the first `-j' option to the revision specified with the
  490.      second `j' option, into the working directory.
  491.      With one `-j' option, merge changes from the ancestor revision to
  492.      the revision specified with the `-j' option, into the working
  493.      directory.  The ancestor revision is the common ancestor of the
  494.      revision which the working directory is based on, and the revision
  495.      specified in the `-j' option.
  496.      In addition, each `-j' option can contain an optional date
  497.      specification which, when used with branches, can limit the chosen
  498.      revision to one within a specific date.  An optional date is
  499.      specified by adding a colon (:) to the tag:
  500.      `-jSYMBOLIC_TAG:DATE_SPECIFIER'.
  501.      *Note Branching and merging::.
  502. File: cvs.info,  Node: update output,  Prev: update options,  Up: update
  503. update output
  504. -------------
  505.    `update' and `checkout' keep you informed of their progress by
  506. printing a line for each file, preceded by one character indicating the
  507. status of the file:
  508. `U FILE'
  509.      The file was brought up to date with respect to the repository.
  510.      This is done for any file that exists in the repository but not in
  511.      your source, and for files that you haven't changed but are not
  512.      the most recent versions available in the repository.
  513. `P FILE'
  514.      Like `U', but the CVS server sends a patch instead of an entire
  515.      file.  These two things accomplish the same thing.
  516. `A FILE'
  517.      The file has been added to your private copy of the sources, and
  518.      will be added to the source repository when you run `commit' on
  519.      the file.  This is a reminder to you that the file needs to be
  520.      committed.
  521. `R FILE'
  522.      The file has been removed from your private copy of the sources,
  523.      and will be removed from the source repository when you run
  524.      `commit' on the file.  This is a reminder to you that the file
  525.      needs to be committed.
  526. `M FILE'
  527.      The file is modified in  your  working  directory.
  528.      `M' can indicate one of two states for a file you're working on:
  529.      either there were no modifications to the same file in the
  530.      repository, so that your file remains as you last saw it; or there
  531.      were modifications in the repository as well as in your copy, but
  532.      they were merged successfully, without conflict, in your working
  533.      directory.
  534.      CVS will print some messages if it merges your work, and a backup
  535.      copy of your working file (as it looked before you ran `update')
  536.      will be made.  The exact name of that file is printed while
  537.      `update' runs.
  538. `C FILE'
  539.      A conflict was detected while trying to merge your changes to FILE
  540.      with changes from the source repository.  FILE (the copy in your
  541.      working directory) is now the result of attempting to merge the
  542.      two revisions; an unmodified copy of your file is also in your
  543.      working directory, with the name `.#FILE.REVISION' where REVISION
  544.      is the revision that your modified file started from.  Resolve the
  545.      conflict as described in *Note Conflicts example::.  (Note that
  546.      some systems automatically purge files that begin with `.#' if
  547.      they have not been accessed for a few days.  If you intend to keep
  548.      a copy of your original file, it is a very good idea to rename
  549.      it.)  Under VMS, the file name starts with `__' rather than `.#'.
  550. `? FILE'
  551.      FILE is in your working directory, but does not correspond to
  552.      anything in the source repository, and is not in the list of files
  553.      for CVS to ignore (see the description of the `-I' option, and
  554.      *note cvsignore::.).
  555. File: cvs.info,  Node: Invoking CVS,  Next: Administrative files,  Prev: CVS commands,  Up: Top
  556. Quick reference to CVS commands
  557. *******************************
  558.    This appendix describes how to invoke CVS, with references to where
  559. each command or feature is described in detail.  For other references
  560. run the `cvs --help' command, or see *Note Index::.
  561.    A CVS command looks like:
  562.      cvs [ GLOBAL_OPTIONS ] COMMAND [ COMMAND_OPTIONS ] [ COMMAND_ARGS ]
  563.    Global options:
  564. `--allow-root=ROOTDIR'
  565.      Specify legal CVSROOT directory (server only) (not in CVS 1.9 and
  566.      older).  See *Note Password authentication server::.
  567.      Authenticate all communication (client only) (not in CVS 1.9 and
  568.      older).  See *Note Global options::.
  569.      Specify RCS location (CVS 1.9 and older).  See *Note Global
  570.      options::.
  571. `-d ROOT'
  572.      Specify the CVSROOT.  See *Note Repository::.
  573. `-e EDITOR'
  574.      Edit messages with EDITOR.  See *Note Committing your changes::.
  575.      Do not read the `~/.cvsrc' file.  See *Note Global options::.
  576. `--help'
  577.      Print a help message.  See *Note Global options::.
  578.      Do not log in CVSROOT/history file.  See *Note Global options::.
  579.      Do not change any files.  See *Note Global options::.
  580.      Be really quiet.  See *Note Global options::.
  581.      Be somewhat quiet.  See *Note Global options::.
  582.      Make new working files read-only.  See *Note Global options::.
  583. `-s VARIABLE=VALUE'
  584.      Set a user variable.  See *Note Variables::.
  585. `-T TEMPDIR'
  586.      Put temporary files in TEMPDIR.  See *Note Global options::.
  587.      Trace CVS execution.  See *Note Global options::.
  588. `--version'
  589.      Display version and copyright information for CVS.
  590.      Make new working files read-write.  See *Note Global options::.
  591.      Encrypt all communication (client only).  See *Note Global
  592.      options::.
  593. `-z GZIP-LEVEL'
  594.      Set the compression level (client only).
  595.    Keyword expansion modes (*note Substitution modes::.):
  596.      -kkv  $Id: file1,v 1.1 1993/12/09 03:21:13 joe Exp $
  597.      -kkvl $Id: file1,v 1.1 1993/12/09 03:21:13 joe Exp harry $
  598.      -kk   $Id$
  599.      -kv   file1,v 1.1 1993/12/09 03:21:13 joe Exp
  600.      -ko   no expansion
  601.      -kb   no expansion, file is binary
  602.    Keywords (*note Keyword list::.):
  603.      $Author: joe $
  604.      $Date: 1993/12/09 03:21:13 $
  605.      $Header: /home/files/file1,v 1.1 1993/12/09 03:21:13 joe Exp harry $
  606.      $Id: file1,v 1.1 1993/12/09 03:21:13 joe Exp harry $
  607.      $Locker: harry $
  608.      $Name: snapshot_1_14 $
  609.      $RCSfile: file1,v $
  610.      $Revision: 1.1 $
  611.      $Source: /home/files/file1,v $
  612.      $State: Exp $
  613.      $Log: file1,v $
  614.      Revision 1.1  1993/12/09 03:30:17  joe
  615.      Initial revision
  616.    Commands, command options, and command arguments:
  617. `add [OPTIONS] [FILES...]'
  618.      Add a new file/directory.  See *Note Adding files::.
  619.     `-k KFLAG'
  620.           Set keyword expansion.
  621.     `-m MSG'
  622.           Set file description.
  623. `admin [OPTIONS] [FILES...]'
  624.      Administration of history files in the repository.  See *Note
  625.      admin::.
  626.     `-b[REV]'
  627.           Set default branch.  See *Note Reverting local changes::.
  628.     `-cSTRING'
  629.           Set comment leader.
  630.     `-kSUBST'
  631.           Set keyword substitution.  See *Note Keyword substitution::.
  632.     `-l[REV]'
  633.           Lock revision REV, or latest revision.
  634.     `-mREV:MSG'
  635.           Replace the log message of revision REV with MSG.
  636.     `-oRANGE'
  637.           Delete revisions from the repository.  See *Note admin
  638.           options::.
  639.     `-q'
  640.           Run quietly; do not print diagnostics.
  641.     `-sSTATE[:REV]'
  642.           Set the state.
  643.     `-t'
  644.           Set file description from standard input.
  645.     `-tFILE'
  646.           Set file description from FILE.
  647.     `-t-STRING'
  648.           Set file description to STRING.
  649.     `-u[REV]'
  650.           Unlock revision REV, or latest revision.
  651. `annotate [OPTIONS] [FILES...]'
  652.      Show last revision where each line was modified.  See *Note
  653.      annotate::.
  654.     `-D DATE'
  655.           Annotate the most recent revision no later than DATE.  See
  656.           *Note Common options::.
  657.     `-f'
  658.           Use head revision if tag/date not found.  See *Note Common
  659.           options::.
  660.     `-l'
  661.           Local; run only in current working directory.  *Note
  662.           Recursive behavior::.
  663.     `-R'
  664.           Operate recursively (default).  *Note Recursive behavior::.
  665.     `-r TAG'
  666.           Annotate revision TAG.  See *Note Common options::.
  667. `checkout [OPTIONS] MODULES...'
  668.      Get a copy of the sources.  See *Note checkout::.
  669.     `-A'
  670.           Reset any sticky tags/date/options.  See *Note Sticky tags::
  671.           and *Note Keyword substitution::.
  672.     `-c'
  673.           Output the module database.  See *Note checkout options::.
  674.     `-D DATE'
  675.           Check out revisions as of DATE (is sticky).  See *Note Common
  676.           options::.
  677.     `-d DIR'
  678.           Check out into DIR.  See *Note checkout options::.
  679.     `-f'
  680.           Use head revision if tag/date not found.  See *Note Common
  681.           options::.
  682.     `-j REV'
  683.           Merge in changes.  See *Note checkout options::.
  684.     `-k KFLAG'
  685.           Use KFLAG keyword expansion.  See *Note Substitution modes::.
  686.     `-l'
  687.           Local; run only in current working directory.  *Note
  688.           Recursive behavior::.
  689.     `-N'
  690.           Don't "shorten" module paths if -d specified.  See *Note
  691.           checkout options::.
  692.     `-n'
  693.           Do not run module program (if any).  See *Note checkout
  694.           options::.
  695.     `-P'
  696.           Prune empty directories.  See *Note Moving directories::.
  697.     `-p'
  698.           Check out files to standard output (avoids stickiness).  See
  699.           *Note checkout options::.
  700.     `-R'
  701.           Operate recursively (default).  *Note Recursive behavior::.
  702.     `-r TAG'
  703.           Checkout revision TAG (is sticky).  See *Note Common
  704.           options::.
  705.     `-s'
  706.           Like -c, but include module status.  See *Note checkout
  707.           options::.
  708. `commit [OPTIONS] [FILES...]'
  709.      Check changes into the repository.  See *Note commit::.
  710.     `-F FILE'
  711.           Read log message from FILE.  See *Note commit options::.
  712.     `-f'
  713.           Force the file to be committed; disables recursion.  See
  714.           *Note commit options::.
  715.     `-l'
  716.           Local; run only in current working directory.  See *Note
  717.           Recursive behavior::.
  718.     `-m MSG'
  719.           Use MSG as log message.  See *Note commit options::.
  720.     `-n'
  721.           Do not run module program (if any).  See *Note commit
  722.           options::.
  723.     `-R'
  724.           Operate recursively (default).  *Note Recursive behavior::.
  725.     `-r REV'
  726.           Commit to REV.  See *Note commit options::.
  727. `diff [OPTIONS] [FILES...]'
  728.      Show differences between revisions.  See *Note diff::.  In
  729.      addition to the options shown below, accepts a wide variety of
  730.      options to control output style, for example `-c' for context
  731.      diffs.
  732.     `-D DATE1'
  733.           Diff revision for date against working file.  See *Note diff
  734.           options::.
  735.     `-D DATE2'
  736.           Diff REV1/DATE1 against DATE2.  See *Note diff options::.
  737.     `-l'
  738.           Local; run only in current working directory.  See *Note
  739.           Recursive behavior::.
  740.     `-N'
  741.           Include diffs for added and removed files.  See *Note diff
  742.           options::.
  743.     `-R'
  744.           Operate recursively (default).  *Note Recursive behavior::.
  745.     `-r REV1'
  746.           Diff revision for REV1 against working file.  See *Note diff
  747.           options::.
  748.     `-r REV2'
  749.           Diff REV1/DATE1 against REV2.  See *Note diff options::.
  750. `edit [OPTIONS] [FILES...]'
  751.      Get ready to edit a watched file.  See *Note Editing files::.
  752.     `-a ACTIONS'
  753.           Specify actions for temporary watch, where ACTIONS is `edit',
  754.           `unedit', `commit', `all', or `none'.  See *Note Editing
  755.           files::.
  756.     `-l'
  757.           Local; run only in current working directory.  See *Note
  758.           Recursive behavior::.
  759.     `-R'
  760.           Operate recursively (default).  *Note Recursive behavior::.
  761. `editors [OPTIONS] [FILES...]'
  762.      See who is editing a watched file.  See *Note Watch information::.
  763.     `-l'
  764.           Local; run only in current working directory.  See *Note
  765.           Recursive behavior::.
  766.     `-R'
  767.           Operate recursively (default).  *Note Recursive behavior::.
  768. `export [OPTIONS] MODULES...'
  769.      Export files from CVS.  See *Note export::.
  770.     `-D DATE'
  771.           Check out revisions as of DATE.  See *Note Common options::.
  772.     `-d DIR'
  773.           Check out into DIR.  See *Note export options::.
  774.     `-f'
  775.           Use head revision if tag/date not found.  See *Note Common
  776.           options::.
  777.     `-k KFLAG'
  778.           Use KFLAG keyword expansion.  See *Note Substitution modes::.
  779.     `-l'
  780.           Local; run only in current working directory.  *Note
  781.           Recursive behavior::.
  782.     `-N'
  783.           Don't "shorten" module paths if -d specified.  See *Note
  784.           export options::.
  785.     `-n'
  786.           Do not run module program (if any).  See *Note export
  787.           options::.
  788.     `-P'
  789.           Prune empty directories.  See *Note Moving directories::.
  790.     `-R'
  791.           Operate recursively (default).  *Note Recursive behavior::.
  792.     `-r TAG'
  793.           Checkout revision TAG (is sticky).  See *Note Common
  794.           options::.
  795. `history [OPTIONS] [FILES...]'
  796.      Show repository access history.  See *Note history::.
  797.     `-a'
  798.           All users (default is self).  See *Note history options::.
  799.     `-b STR'
  800.           Back to record with STR in module/file/repos field.  See
  801.           *Note history options::.
  802.     `-c'
  803.           Report on committed (modified) files.  See *Note history
  804.           options::.
  805.     `-D DATE'
  806.           Since DATE.  See *Note history options::.
  807.     `-e'
  808.           Report on all record types.  See *Note history options::.
  809.     `-l'
  810.           Last modified (committed or modified report).  See *Note
  811.           history options::.
  812.     `-m MODULE'
  813.           Report on MODULE (repeatable).  See *Note history options::.
  814.     `-n MODULE'
  815.           In MODULE.  See *Note history options::.
  816.     `-o'
  817.           Report on checked out modules.  See *Note history options::.
  818.     `-r REV'
  819.           Since revision REV.  See *Note history options::.
  820.     `-T'
  821.           Produce report on all TAGs.  See *Note history options::.
  822.     `-t TAG'
  823.           Since tag record placed in history file (by anyone).  See
  824.           *Note history options::.
  825.     `-u USER'
  826.           For user USER (repeatable).  See *Note history options::.
  827.     `-w'
  828.           Working directory must match.  See *Note history options::.
  829.     `-x TYPES'
  830.           Report on TYPES, one or more of `TOEFWUCGMAR'.  See *Note
  831.           history options::.
  832.     `-z ZONE'
  833.           Output for time zone ZONE.  See *Note history options::.
  834. `import [OPTIONS] REPOSITORY VENDOR-TAG RELEASE-TAGS...'
  835.      Import files into CVS, using vendor branches.  See *Note import::.
  836.     `-b BRA'
  837.           Import to vendor branch BRA.  See *Note Multiple vendor
  838.           branches::.
  839.     `-d'
  840.           Use the file's modification time as the time of import.  See
  841.           *Note import options::.
  842.     `-k KFLAG'
  843.           Set default keyword substitution mode.  See *Note import
  844.           options::.
  845.     `-m MSG'
  846.           Use MSG for log message.  See *Note import options::.
  847.     `-I IGN'
  848.           More files to ignore (! to reset).  See *Note import
  849.           options::.
  850.     `-W SPEC'
  851.           More wrappers.  See *Note import options::.
  852. `init'
  853.      Create a CVS repository if it doesn't exist.  See *Note Creating a
  854.      repository::.
  855. `log [OPTIONS] [FILES...]'
  856.      Print out history information for files.  See *Note log::.
  857.     `-b'
  858.           Only list revisions on the default branch.  See *Note log
  859.           options::.
  860.     `-d DATES'
  861.           Specify dates (D1<D2 for range, D for latest before).  See
  862.           *Note log options::.
  863.     `-h'
  864.           Only print header.  See *Note log options::.
  865.     `-l'
  866.           Local; run only in current working directory.  See *Note
  867.           Recursive behavior::.
  868.     `-N'
  869.           Do not list tags.  See *Note log options::.
  870.     `-R'
  871.           Only print name of RCS file.  See *Note log options::.
  872.     `-rREVS'
  873.           Only list revisions REVS.  See *Note log options::.
  874.     `-s STATES'
  875.           Only list revisions with specified states.  See *Note log
  876.           options::.
  877.     `-t'
  878.           Only print header and descriptive text.  See *Note log
  879.           options::.
  880.     `-wLOGINS'
  881.           Only list revisions checked in by specified logins.  See
  882.           *Note log options::.
  883. `login'
  884.      Prompt for password for authenticating server.  See *Note Password
  885.      authentication client::.
  886. `logout'
  887.      Remove stored password for authenticating server.  See *Note
  888.      Password authentication client::.
  889. `rdiff [OPTIONS] MODULES...'
  890.      Show differences between releases.  See *Note rdiff::.
  891.     `-c'
  892.           Context diff output format (default).  See *Note rdiff
  893.           options::.
  894.     `-D DATE'
  895.           Select revisions based on DATE.  See *Note Common options::.
  896.     `-f'
  897.           Use head revision if tag/date not found.  See *Note Common
  898.           options::.
  899.     `-l'
  900.           Local; run only in current working directory.  See *Note
  901.           Recursive behavior::.
  902.     `-R'
  903.           Operate recursively (default).  *Note Recursive behavior::.
  904.     `-r REV'
  905.           Select revisions based on REV.  See *Note Common options::.
  906.     `-s'
  907.           Short patch - one liner per file.  See *Note rdiff options::.
  908.     `-t'
  909.           Top two diffs - last change made to the file.  See *Note diff
  910.           options::.
  911.     `-u'
  912.           Unidiff output format.  See *Note rdiff options::.
  913.     `-V VERS'
  914.           Use RCS Version VERS for keyword expansion (obsolete).  See
  915.           *Note rdiff options::.
  916. `release [OPTIONS] DIRECTORY'
  917.      Indicate that a directory is no longer in use.  See *Note
  918.      release::.
  919.     `-d'
  920.           Delete the given directory.  See *Note release options::.
  921. `remove [OPTIONS] [FILES...]'
  922.      Remove an entry from the repository.  See *Note Removing files::.
  923.     `-f'
  924.           Delete the file before removing it.  See *Note Removing
  925.           files::.
  926.     `-l'
  927.           Local; run only in current working directory.  See *Note
  928.           Recursive behavior::.
  929.     `-R'
  930.           Operate recursively (default).  *Note Recursive behavior::.
  931. `rtag [OPTIONS] TAG MODULES...'
  932.      Add a symbolic tag to a module.  See *Note rtag::.
  933.     `-a'
  934.           Clear tag from removed files that would not otherwise be
  935.           tagged.  See *Note rtag options::.
  936.     `-b'
  937.           Create a branch named TAG.  See *Note rtag options::.
  938.     `-D DATE'
  939.           Tag revisions as of DATE.  See *Note rtag options::.
  940.     `-d'
  941.           Delete the given tag.  See *Note rtag options::.
  942.     `-F'
  943.           Move tag if it already exists.  See *Note rtag options::.
  944.     `-f'
  945.           Force a head revision match if tag/date not found.  See *Note
  946.           rtag options::.
  947.     `-l'
  948.           Local; run only in current working directory.  See *Note
  949.           Recursive behavior::.
  950.     `-n'
  951.           No execution of tag program.  See *Note rtag options::.
  952.     `-R'
  953.           Operate recursively (default).  *Note Recursive behavior::.
  954.     `-r TAG'
  955.           Tag existing tag TAG.  See *Note rtag options::.
  956. `status [OPTIONS] FILES...'
  957.      Display status information in a working directory.  See *Note File
  958.      status::.
  959.     `-l'
  960.           Local; run only in current working directory.  See *Note
  961.           Recursive behavior::.
  962.     `-R'
  963.           Operate recursively (default).  *Note Recursive behavior::.
  964.     `-v'
  965.           Include tag information for file.  See *Note Tags::.
  966. `tag [OPTIONS] TAG [FILES...]'
  967.      Add a symbolic tag to checked out version of files.  See *Note
  968.      tag::.
  969.     `-b'
  970.           Create a branch named TAG.  See *Note tag options::.
  971.     `-D DATE'
  972.           Tag revisions as of DATE.  See *Note tag options::.
  973.     `-d'
  974.           Delete the given tag.  See *Note tag options::.
  975.     `-F'
  976.           Move tag if it already exists.  See *Note tag options::.
  977.     `-f'
  978.           Force a head revision match if tag/date not found.  See *Note
  979.           tag options::.
  980.     `-l'
  981.           Local; run only in current working directory.  See *Note
  982.           Recursive behavior::.
  983.     `-n'
  984.           No execution of tag program.  See *Note tag options::.
  985.     `-R'
  986.           Operate recursively (default).  *Note Recursive behavior::.
  987.     `-r TAG'
  988.           Tag existing tag TAG.  See *Note tag options::.
  989. `unedit [OPTIONS] [FILES...]'
  990.      Undo an edit command.  See *Note Editing files::.
  991.     `-a ACTIONS'
  992.           Specify actions for temporary watch, where ACTIONS is `edit',
  993.           `unedit', `commit', `all', or `none'.  See *Note Editing
  994.           files::.
  995.     `-l'
  996.           Local; run only in current working directory.  See *Note
  997.           Recursive behavior::.
  998.     `-R'
  999.           Operate recursively (default).  *Note Recursive behavior::.
  1000. `update [OPTIONS] [FILES...]'
  1001.      Bring work tree in sync with repository.  See *Note update::.
  1002.     `-A'
  1003.           Reset any sticky tags/date/options.  See *Note Sticky tags::
  1004.           and *Note Keyword substitution::.
  1005.     `-D DATE'
  1006.           Check out revisions as of DATE (is sticky).  See *Note Common
  1007.           options::.
  1008.     `-d'
  1009.           Create directories.  See *Note update options::.
  1010.     `-f'
  1011.           Use head revision if tag/date not found.  See *Note Common
  1012.           options::.
  1013.     `-I IGN'
  1014.           More files to ignore (! to reset).  See *Note import
  1015.           options::.
  1016.     `-j REV'
  1017.           Merge in changes.  See *Note update options::.
  1018.     `-k KFLAG'
  1019.           Use KFLAG keyword expansion.  See *Note Substitution modes::.
  1020.     `-l'
  1021.           Local; run only in current working directory.  *Note
  1022.           Recursive behavior::.
  1023.     `-P'
  1024.           Prune empty directories.  See *Note Moving directories::.
  1025.     `-p'
  1026.           Check out files to standard output (avoids stickiness).  See
  1027.           *Note update options::.
  1028.     `-R'
  1029.           Operate recursively (default).  *Note Recursive behavior::.
  1030.     `-r TAG'
  1031.           Checkout revision TAG (is sticky).  See *Note Common
  1032.           options::.
  1033.     `-W SPEC'
  1034.           More wrappers.  See *Note import options::.
  1035. `watch [on|off|add|remove] [OPTIONS] [FILES...]'
  1036.      on/off: turn on/off read-only checkouts of files.  See *Note
  1037.      Setting a watch::.
  1038.      add/remove: add or remove notification on actions.  See *Note
  1039.      Getting Notified::.
  1040.     `-a ACTIONS'
  1041.           Specify actions for temporary watch, where ACTIONS is `edit',
  1042.           `unedit', `commit', `all', or `none'.  See *Note Editing
  1043.           files::.
  1044.     `-l'
  1045.           Local; run only in current working directory.  See *Note
  1046.           Recursive behavior::.
  1047.     `-R'
  1048.           Operate recursively (default).  *Note Recursive behavior::.
  1049. `watchers [OPTIONS] [FILES...]'
  1050.      See who is watching a file.  See *Note Watch information::.
  1051.     `-l'
  1052.           Local; run only in current working directory.  See *Note
  1053.           Recursive behavior::.
  1054.     `-R'
  1055.           Operate recursively (default).  *Note Recursive behavior::.
  1056. File: cvs.info,  Node: Administrative files,  Next: Environment variables,  Prev: Invoking CVS,  Up: Top
  1057. Reference manual for Administrative files
  1058. *****************************************
  1059.    Inside the repository, in the directory `$CVSROOT/CVSROOT', there
  1060. are a number of supportive files for CVS.  You can use CVS in a limited
  1061. fashion without any of them, but if they are set up properly they can
  1062. help make life easier.  For a discussion of how to edit them, see *Note
  1063. Intro administrative files::.
  1064.    The most important of these files is the `modules' file, which
  1065. defines the modules inside the repository.
  1066. * Menu:
  1067. * modules::                     Defining modules
  1068. * Wrappers::                    Treat directories as files
  1069. * commit files::                The commit support files
  1070. * commitinfo::                  Pre-commit checking
  1071. * verifymsg::                   How are log messages evaluated?
  1072. * editinfo::                    Specifying how log messages are created
  1073.                                 (obsolete)
  1074. * loginfo::                     Where should log messages be sent?
  1075. * rcsinfo::                     Templates for the log messages
  1076. * cvsignore::                   Ignoring files via cvsignore
  1077. * history file::                History information
  1078. * Variables::                   Various variables are expanded
  1079. * config::                      Miscellaneous CVS configuration
  1080. File: cvs.info,  Node: modules,  Next: Wrappers,  Up: Administrative files
  1081. The modules file
  1082. ================
  1083.    The `modules' file records your definitions of names for collections
  1084. of source code.  CVS will use these definitions if you use CVS to
  1085. update the modules file (use normal commands like `add', `commit', etc).
  1086.    The `modules' file may contain blank lines and comments (lines
  1087. beginning with `#') as well as module definitions.  Long lines can be
  1088. continued on the next line by specifying a backslash (`\') as the last
  1089. character on the line.
  1090.    There are three basic types of modules: alias modules, regular
  1091. modules, and ampersand modules.  The difference between them is the way
  1092. that they map files in the repository to files in the working
  1093. directory.  In all of the following examples, the top-level repository
  1094. contains a directory called `first-dir', which contains two files,
  1095. `file1' and `file2', and a directory `sdir'.  `first-dir/sdir' contains
  1096. a file `sfile'.
  1097. * Menu:
  1098. * Alias modules::             The simplest kind of module
  1099. * Regular modules::
  1100. * Ampersand modules::
  1101. * Excluding directories::     Excluding directories from a module
  1102. * Module options::            Regular and ampersand modules can take options
  1103.